<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.11"/>
<title>Icarous: SBN Serial Module Configuration</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Icarous
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li class="current"><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="serial.html">CFS Software Bus Network Serial Module</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle">
<div class="title">SBN Serial Module Configuration </div>  </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><h1>SBN Peer Data File Entry</h1>
<p>The file entry in SbnPeerData.dat for a Serial interface requires 7 fields. The first 4 fields are the fields required of all interface modules: </p><ul>
<li>
Peer Name </li>
<li>
Processor ID </li>
<li>
Protocol ID (6 for Serial) </li>
<li>
Spacecraft ID </li>
</ul>
<p>The remaining fields are the interface specific fields that are determined by the device driver's behavior: </p><ul>
<li>
Pair Number, a number that is used to identify two lines in the file as "paired" (connected by the serial wire) </li>
<li>
Device Name, as it would appear on the file system (e.g. /dev/ttyS0) </li>
<li>
Baud Rate, the desired baud rate for the serial port </li>
</ul>
<p>These three fields have some constraints on their values:</p>
<p><b>Pair Number</b> </p><ul>
<li>
The two lines representing a host/peer pair connected by a serial wire must have the same pair number. </li>
<li>
Pair numbers must be unique across pairs of lines </li>
</ul>
<p><b>Device Name:</b> The serial Device Name value is defined by the device driver.</p>
<p><b>Baud Rate:</b> </p><ul>
<li>
Valid values for Linux are 38400, 57600, 115200, 230400. Other operating systems are not implemented. </li>
<li>
Larger baud rates are preferred, especially if SBN will be routing messages larger than 100 bytes. However, the highest baud rate may produce tty overruns so test different baud rates for your specific system. </li>
</ul>
<p>In order for the serial interface to work, there must be a "matching" set of two peers for each serial wire. Two peers "match" if they have the same pair number and the same baud rate. An example of serial entries is below, showing a setup where CPU1 has two serial connections: one to CPU2 and one to CPU3.</p>
<table  border="1" cellpadding="2" width="60%">
<tr>
<td width="5%"><b>Name</b> </td><td width="10%"><b>Processor ID</b> </td><td width="10%"><b>Protocol ID</b> </td><td width="10%"><b>Spacecraft ID</b> </td><td width="10%"><b>Pair Number</b> </td><td width="10%"><b>Device Name</b> </td><td width="10%"><b>Baud Rate</b>  </td></tr>
<tr>
<td width="5%">CPU1 </td><td width="10%">1 </td><td width="10%">6 </td><td width="10%">0 </td><td width="10%">1 </td><td width="10%">/dev/ttyS0 </td><td width="10%">115200  </td></tr>
<tr>
<td width="5%">CPU2 </td><td width="10%">2 </td><td width="10%">6 </td><td width="10%">0 </td><td width="10%">1 </td><td width="10%">/dev/ttyS0 </td><td width="10%">115200  </td></tr>
<tr>
<td width="5%">CPU1 </td><td width="10%">1 </td><td width="10%">6 </td><td width="10%">0 </td><td width="10%">2 </td><td width="10%">/dev/ttyS1 </td><td width="10%">115200  </td></tr>
<tr>
<td width="5%">CPU3 </td><td width="10%">3 </td><td width="10%">6 </td><td width="10%">0 </td><td width="10%">2 </td><td width="10%">/dev/ttyS0 </td><td width="10%">115200  </td></tr>
</table>
<p>Next: <a class="el" href="sbnserialcons.html">SBN Serial Module Constraints</a> <br />
 Prev: <a class="el" href="sbnserialopr.html">SBN Serial Module Operation</a> </p>
</div></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.11
</small></address>
</body>
</html>
